Search Help Contents:

Topics

API Calls

POST /oauth2/token

GET /health

Shipments

Containers

OM Containers

Consignments and Cross-Dock

GET consignments

GET consignments/{id}

GET consignments/{id}/events

GET consignments/{id}/references

GET consignments/exactmatch

GET consignments/{id}/documents

GET consignments/{id}/documents/{documentId}/download

GET consignments/{id}/references

Get a list of references for consignment and cross-dock shipments. Data can be requested for all consignment and cross-dock shipments or only for shipments with trace values matching the given reference, or only for shipments that have been updated between a specific start and end date. If no page size is given, the system returns the first page of a limited number of results (see parameters for defaults).

Example HTTP Request

GET /consignments/5555/references?sizeLimit=1000&offset=0

Authorization: Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic

X-Consumer-ID: TEST_CONSUMER_ID

X-Consumer-Custom-ID: TEST_CUSTOM_CONSUMER_ID

Host: localhost:8080

Example Curl Request

$ curl 'https://localhost:8080/consignments/5555/references?sizeLimit=1000&offset=0' -i -X GET \

-H 'Authorization: Ejr2YotnFZFEjr1zCsicMWpAAotnFZFEjr1zCsic' \

-H 'X-Consumer-ID: TEST_CONSUMER_ID' \

-H 'X-Consumer-Custom-ID: TEST_CUSTOM_CONSUMER_ID'

Parameters

Parameter	Purpose	Values	Required?
id	Identifier for a consignment or cross-dock shipment

Response

The response format is JSON; see Data Types - Consignment and Cross-Dock - References for data types.

Example Result

200 OK

Content-Type: application/json

Content-Length: 130

[ {

"refType" : "Purchase Order",

"refNumber" : "06237325",

"expeditorsReference" : "exp",

"consignment" : "5555"

} ]

All information contained herein is business confidential and proprietary and may not be reproduced in any form without advanced

written consent of an authorized officer of the copyright holder.

EULA - End User License Agreement